/*
 * Copyright (c) 2004-2022, University of Oslo
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 * 1. Redistributions of source code must retain the above copyright notice, this
 * list of conditions and the following disclaimer.
 *
 * 2. Redistributions in binary form must reproduce the above copyright notice,
 * this list of conditions and the following disclaimer in the documentation
 * and/or other materials provided with the distribution.
 *
 * 3. Neither the name of the copyright holder nor the names of its contributors 
 * may be used to endorse or promote products derived from this software without
 * specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
 * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
 * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
package org.hisp.dhis.validation.notification;

import java.util.EnumSet;
import java.util.Map;
import java.util.stream.Collectors;
import org.hisp.dhis.notification.TemplateVariable;

/**
 * @author Halvdan Hoem Grelland
 */
public enum ValidationRuleTemplateVariable implements TemplateVariable {
  RULE_NAME("rule_name"),
  DESCRIPTION("rule_description"),
  OPERATOR("operator"),
  IMPORTANCE("importance"),
  LEFT_SIDE_DESCRIPTION("left_side_description"),
  RIGHT_SIDE_DESCRIPTION("right_side_description"),
  LEFT_SIDE_VALUE("left_side_value"),
  RIGHT_SIDE_VALUE("right_side_value"),
  ORG_UNIT_NAME("org_unit_name"),
  PERIOD("period"),
  CURRENT_DATE("current_date");

  private static final Map<String, ValidationRuleTemplateVariable> variableNameMap =
      EnumSet.allOf(ValidationRuleTemplateVariable.class).stream()
          .collect(Collectors.toMap(ValidationRuleTemplateVariable::getVariableName, e -> e));

  private final String variableName;

  ValidationRuleTemplateVariable(String variableName) {
    this.variableName = variableName;
  }

  @Override
  public String getVariableName() {
    return variableName;
  }

  public static boolean isValidVariableName(String expressionName) {
    return variableNameMap.keySet().contains(expressionName);
  }

  public static ValidationRuleTemplateVariable fromVariableName(String variableName) {
    return variableNameMap.get(variableName);
  }
}
